/*! \file bcmdrd_symbol.c
 *
 * BCMDRD symbol routines.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#include <sal/sal_libc.h>
#include <sal/sal_assert.h>

#include <shr/shr_error.h>

#include <bcmdrd/bcmdrd_field.h>
#include <bcmdrd/bcmdrd_symbols.h>

#if BCMDRD_CONFIG_INCLUDE_CHIP_SYMBOLS == 1

static const bcmdrd_symbol_t *
symbol_from_sid(const bcmdrd_symbols_t *symbols, bcmdrd_sid_t sid)
{
    if (symbols == NULL) {
        return NULL;
    }
    if (sid >= symbols->size) {
        return NULL;
    }
    return &symbols->symbols[sid];
}

const bcmdrd_symbol_t *
bcmdrd_sym_info_get(const bcmdrd_symbols_t *symbols, bcmdrd_sid_t sid,
                    bcmdrd_sym_info_t *sinfo)
{
    const bcmdrd_symbol_t *symbol;
    uint32_t size;

    symbol = symbol_from_sid(symbols, sid);
    if (symbol == NULL) {
        return NULL;
    }

    if (sinfo == NULL) {
        return symbol;
    }

    sal_memset(sinfo, 0, sizeof(*sinfo));
    sinfo->sid = sid;
    sinfo->name = symbol->name;
    sinfo->offset = symbol->addr;
    sinfo->flags = symbol->flags;
    sinfo->blktypes = symbol->info;
    sinfo->index_min = BCMDRD_SYMBOL_INDEX_MIN_GET(symbol->index);
    sinfo->index_max = BCMDRD_SYMBOL_INDEX_MAX_GET(symbol->index);
    size = BCMDRD_SYMBOL_INDEX_SIZE_GET(symbol->index);
    sinfo->entry_wsize = BCMDRD_BYTES2WORDS(size);
    sinfo->step_size = BCMDRD_SYMBOL_INDEX_STEP_GET(symbol->index);

    return symbol;
}

const bcmdrd_symbol_t *
bcmdrd_symbol_find(const char *name,
                   const bcmdrd_symbol_t *table, uint32_t size,
                   bcmdrd_sid_t *sid)
{
    uint32_t idx;
    const bcmdrd_symbol_t *sym = table;

    assert(table);

    for (idx = 0; idx < size; idx++) {
	if (sal_strcmp(sym->name, name) == 0) {
	    break;
	}
#if BCMDRD_CONFIG_INCLUDE_ALIAS_NAMES == 1
	if (sym->ufname && sal_strcmp(sym->ufname, name) == 0) {
	    break;
	}
	if (sym->alias && sal_strcmp(sym->alias, name) == 0) {
	    break;
	}
#endif
	sym++;
    }
    if (idx >= size) {
        sym = NULL;
    } else if (sid) {
        *sid = idx;
    }
    return sym;
}

const bcmdrd_symbol_t *
bcmdrd_symbols_find(const char *name, const bcmdrd_symbols_t *symbols,
                    bcmdrd_sid_t *sid)
{
    if (symbols == NULL || symbols->symbols == NULL) {
        return NULL;
    }

    return bcmdrd_symbol_find(name, symbols->symbols, symbols->size, sid);
}

int
bcmdrd_symbols_get(const bcmdrd_symbols_t *symbols, uint32_t sindex,
                   bcmdrd_symbol_t *rsym)
{
    if (symbols) {
        if (sindex < symbols->size) {
            /* Index is within the symbol table */
            *rsym = symbols->symbols[sindex];
            return 0;
        }
    }
    return -1;
}

int
bcmdrd_symbols_index(const bcmdrd_symbols_t *symbols,
                     const bcmdrd_symbol_t *symbol)
{
    int size, idx;

    if (symbols == NULL || symbols->symbols == NULL) {
        return -1;
    }

    size = symbols->size;
    for (idx = 0; idx < size; idx++) {
        /* Sufficient to compare just the pointers */
        if (symbol->name == symbols->symbols[idx].name) {
            return idx;
        }
    }
    return -1;
}

#endif
